6章 コメントは正確で簡潔に
どうすればコメントを正確で簡潔に書けるかを説明する。
コメントは領域を埋めるので、領域に対する情報の比率を高くする必要がある
6.1 コメントを簡潔にしておく
mapを説明する例:// CategoryType -> (score, weight)
6.2 あいまいな代名詞を避ける
代名詞を使わない(名詞を代入)
6.3 歯切れの悪い文章を磨く
正確なコメントと簡潔なコメントは両立
6.4 関数の動作を正確に記述する
6.5 入出力のコーナーケースに実例を使う
(doctestに通じそう)
6.6 コードの意図を書く
コードの動作を書くのではない。高レベルな意図を書く
(実現したいことが共有できればよりよい書き方にリファクタリングできるということではないか)
6.7 「名前付き引数」コメント
Connect(10, false)
何のことだがよくわからない
Pythonの名前付き引数に言及
Python キーワード引数=名前付き引数
IMO:専用になっていることには価値がある 👉 キーワード専用引数はPython 3.0から
インラインコメントを使って名前付き引数と同じ効果を得る
Connect(/* timeout_ms = */ 10, /* use_encryption = */ false)
IMO:10とfalseをそれぞれ変数に代入して渡す方法もあるのではないか?
他の箇所も見たが『リーダブルコード』では紹介されていないかも(変数は8章・9章)
6.8 情報密度の高い言葉を使う
例:キャッシュ、正規化